home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / bbs / g5109b.zip / G5.ZIP / TEXT / HELP.TXT < prev    next >
Text File  |  1996-11-27  |  26KB  |  444 lines
  1.  
  2.                               ──══ Galaxy 5 ══──
  3.                                 Help With Doors
  4.  
  5.  
  6.      ────────────────────────────────────────────────────────────────────
  7.       This file explains how to setup a door, and the use of fossil
  8.       drivers, and related topics. It is primarily for those who are not
  9.       yet familiar with the setup of doors on their BBS (new SysOps). If
  10.       you already know how to setup doors, then you do not need to read
  11.       this file. It starts from the basics of door setup.
  12.      ────────────────────────────────────────────────────────────────────
  13.       Please keep in mind that I run a Wildcat! 4 system, and will be
  14.       giving many examples using the Wildcat! doors setup. If you are
  15.       running BBS software other than Wildcat!, then setup points
  16.       referred to in this file, may differ slightly, or greatly.
  17.      ────────────────────────────────────────────────────────────────────
  18.  
  19.  
  20.                                   DOOR SETUP
  21.      ────────────────────────────────────────────────────────────────────
  22.       When you first install a door, you should read any documentation
  23.       on the setup of that particular door. Most doors are similiar in
  24.       setup, but alot have their own requirements on setting up.
  25.       Sometimes door authors will include a SYSOP.DOC file with their
  26.       door. This file usually contains everything you need to know on
  27.       how to setup the door. If there is no SYSOP.DOC file, look for
  28.       one or more of these files,
  29.                                  SYSOP.TXT
  30.                                  README.TXT
  31.                                  READ1ST.TXT
  32.                                  README.1ST
  33.                                  INSTALL.TXT
  34.                                  INSTALL.DOC
  35.                                  SETUP.DOC
  36.                                  SETUP.TXT
  37.       If you see any of these files (especially the README files), you
  38.       should refer to them immediately before attempting to install the
  39.       door. If none of the above files are included, then look for a
  40.       .DOC or .TXT file with the same name as the door. Such as
  41.       GALAXY5.DOC for Galaxy 5.
  42.      ────────────────────────────────────────────────────────────────────
  43.       First, if necessary, run the setup program that comes with the
  44.       door (or any install programs needed, or both if necessary). If
  45.       you need to edit a .CFG file, then do that also. In some setup
  46.       programs, and/or .CFG files, you will be asked where the door can
  47.       find your BBS drop file. Drop files have different names for
  48.       different BBS platforms, and some use the same drop files. Here is
  49.       a list of a few of them,
  50.                               DOOR.SYS
  51.                               DORINFO*.DEF
  52.                               CALLINFO.BBS
  53.                               PCBOARD.SYS
  54.                               SFDOORS.DAT
  55.       Among many others. Many new SysOps ask the common question, "I
  56.       don't have a DOOR.SYS file! Where is mine?" Or whatever drop file
  57.       your BBS uses. The answer is simple, there isn't one! These files
  58.       are temporary files created when a user uses a door on your BBS.
  59.       The door then reads this drop file to gather caller information
  60.       such as name, security level, time left on BBS, COM port info,
  61.       etc. After the door exits, and your BBS returns, the drop file is
  62.       erased. So you will not see a door drop file at any given time,
  63.       unless you are in another "window" in a multi-tasking environment,
  64.       looking in the drop file directory while a caller is using a door.
  65.      ────────────────────────────────────────────────────────────────────
  66.       Sometimes the door configuration will ask for your drop file type.
  67.       This is where you either use the file name of the drop file your
  68.       BBS creates, or a special abbreviation or other code the door uses
  69.       for each different type of drop file (the config file or setup
  70.       program will usually inform you of the code to use if any). Then
  71.       you may be asked for the directory where to find this drop file. A
  72.       Wildcat! single node system would use the C:\WILDCAT\WCWORK\NODE1
  73.       directory (replacing C:\WILDCAT with your home Wildcat!
  74.       directory). And sometimes the door configuration will ask for the
  75.       full path and file name of the drop file. A Wildcat! single node
  76.       system would use, C:\WILDCAT\WCWORK\NODE1\DOOR.SYS (again
  77.       replacing the C:\WILDCAT with your home Wildcat! directory).
  78.      ────────────────────────────────────────────────────────────────────
  79.  
  80.  
  81.                          SETTING UP THE BATCH FILE(S)
  82.      ────────────────────────────────────────────────────────────────────
  83.       The most important thing you probably need to look for, in the
  84.       documentation, is how to set up the batch file(s) for the door.
  85.       The batch file(s) to run the door, are ran from your BBS software.
  86.       In a Wildcat! 4 setup, these batch files have the .BAT extension,
  87.       and are placed in the WILDCAT\BATCH subdirectory. Here is a basic
  88.       example of a batch file used to run a door when the BBS is setup
  89.       to "shell" to doors instead of terminating (the recommended
  90.       setting),
  91.                @ECHO OFF
  92.                D:
  93.                CD\DOORS\DOORNAME
  94.                DOORNAME FILENAME.CFG
  95.  
  96.        Here are explanations of each command
  97.       ---------------------------------------
  98.       @ECHO OFF - This turns of echoing these commands to your screen.
  99.                   It is not really a necessary command, but is used by
  100.                   many SysOps (including myself!).
  101.  
  102.       D:        - This is only needed if your doors are located on a
  103.                   different drive than your BBS software. It will change
  104.                   to that drive before executing the door.
  105.  
  106.       CD\DOORS\DOORNAME - Changes to the directory containing the door
  107.                           about to be executed. Most of the time, this
  108.                           is necessary for the door program to be able
  109.                           to find its program files. If you use a
  110.                           command like,
  111.                           D:\DOORS\DOORNAME\DOORNAME.EXE FILENAME.CFG,
  112.                           then if the door needs to use any external
  113.                           program files, it will not be able to find
  114.                           them, because you are actually running the
  115.                           door from your drop file directory this way,
  116.                           instead of the doors own directory.
  117.  
  118.       DOORNAME FILENAME.CFG - Executes the door using the configuration
  119.                               file as the command line (if needed). Here
  120.                               is where door batch files usually get
  121.                               tricky. Many doors use many different
  122.                               command line parameters (the command line
  123.                               parameter in this case is the FILENAME.CFG
  124.                               command) to initiate the door. You will
  125.                               have to find out what command line
  126.                               parameters you need to use to execute each
  127.                               door from your BBS batch file, in one of
  128.                               the documentation files explained earlier.
  129.                               Most doors need the name of the config
  130.                               file as the only parameter, but this is
  131.                               not always the case, so you really should
  132.                               look at the docs to find out what
  133.                               parameters you need to use.
  134.      ────────────────────────────────────────────────────────────────────
  135.       Case is not important in your batch file(s). Upper or lower case
  136.       can be used anywhere in the above commands.
  137.      ────────────────────────────────────────────────────────────────────
  138.       Sometimes you will need to change back to your drop file directory
  139.       after the door is run (if required by your BBS software). If so,
  140.       then you will have to add the "CD" command again to the end of the
  141.       batch file. If you changed to another drive letter at the
  142.       beginning of the batch file, then you will need to first change
  143.       back to your BBS drive before changing back to your drop file
  144.       directory. Here is an entire batch file example, with Wildcat!
  145.       being on the C: drive, and the doors being on the D: drive, and
  146.       changing back to the drop file directory after the door is run,
  147.  
  148.       @ECHO OFF
  149.       D:
  150.       CD\DOORS\DOORNAME
  151.       DOORNAME FILENAME.CFG
  152.       C:
  153.       CD\WILDCAT\WCWORK\NODE1
  154.  
  155.       As far as I know, Wildcat! does not require you to do this, but I
  156.       do it myself anyway. I know from experience that it WILL work
  157.       properly without changing back to the drop file directory at the
  158.       end of your batch file.
  159.      ────────────────────────────────────────────────────────────────────
  160.  
  161.  
  162.                         SETTING UP THE DOOR IN YOUR BBS
  163.      ────────────────────────────────────────────────────────────────────
  164.       Now you will need to tell your BBS software about the door. I
  165.       honestly have no idea how to do this in any other BBS software
  166.       besides Wildcat! So I will explain how to do it in Wildcat!, and
  167.       maybe you can relate the info to your BBS software if you run any
  168.       other than Wildcat! Note that this is Wildcat! 4 setup, and that I
  169.       plum forgot how to do it in Wildcat! 3, since its been so long! ;>
  170.  
  171.       1) Run MakeWild, and choose the "Doors" main menu option.
  172.       2) Move your highlight bar to the very last door (which is empty),
  173.          and press ENTER (or double click on the empty one).
  174.       3) It will ask you something like, "Clear door access for this
  175.          door?" Select Yes.
  176.       4) You are then editing the doors info. The first box asks for the
  177.          door description. Enter the name of the door here (this can be
  178.          worded however you wish). Next is the door batch file. Enter
  179.          here whatever you named the batch file for this door (usually
  180.          named to match the door it is for). You should have already
  181.          placed this batch file in your WILDCAT\BATCH subdirectory. In
  182.          the next box you enter the display file you want shown to users
  183.          upon choosing to enter the door (I do not currently use this
  184.          feature myself, it is optional if you wish to use it). The next
  185.          one is the "Door Multi User?" flag. If the door allows more
  186.          than one caller to use the door at the same time, then change
  187.          it to Y, otherwise, leave it at N. The next one, "Small
  188.          DOOR.SYS," I have never had to answer Y to this one yet, so
  189.          unless the door you are installing needs a small DOOR.SYS,
  190.          leave this one at N. "Use Alias Name" This one is up to you. If
  191.          you set it to Yes, then the real name of the caller will not be
  192.          passed to the door in the DOOR.SYS file, only his/her alias. I
  193.          have so far, always left this at No. "Terminate On Door." This
  194.          one if set to yes, Wildcat! will terminate, and then execute
  195.          the door instead of "shelling" out to it. I have not explained
  196.          the use of terminating on doors instead of shelling. So if you
  197.          wish to continue using this file as your guide for now, leave
  198.          this at N. I do not terminate on my doors, as I have not had
  199.          the need to.
  200.       5) After filling in all of the fields, press F3 (or double click
  201.          on it), and select all security levels who are allowed access
  202.          to the door. Then press F4 (or double click on it), and select
  203.          all of the conferences this door is available in. I always
  204.          select all conferences for every door, but this is up to you,
  205.          and how you want to set up your doors on your system.
  206.       6) Press F10 to save it.
  207.       7) Load WCdraw, and add the door to your DOORS.BBS display file.
  208.      ────────────────────────────────────────────────────────────────────
  209.       As I mentioned before, if you are not running a Wildcat! system,
  210.       then you will have to set up your doors in your BBS however you
  211.       are supposed to do so according to your particular software.
  212.      ────────────────────────────────────────────────────────────────────
  213.  
  214.  
  215.                                MULTI NODE SETUP
  216.      ────────────────────────────────────────────────────────────────────
  217.       If you are running more than one node on your BBS, and want to set
  218.       up doors, it gets a little more complicated, but once you
  219.       understand it, its really not that hard to comprehend (unless the
  220.       door you are installing is not very multi node friendly). Most
  221.       doors are set up for use by one caller at a time. If this is the
  222.       case, then you can still set up the door on all of your nodes, but
  223.       will have to "disallow" more than one person from using it at the
  224.       same time. Most BBS platforms allow you to do this when setting
  225.       the door up in your BBS configuration program. For instance,
  226.       Wildcat! has a flag for each door in the door setup called "Door
  227.       Multi User?" If the door cannot be used by more than one caller at
  228.       a time, then you must set this to NO. On the other hand, if the
  229.       door you are installing is multi node aware, and allows more than
  230.       one player to use it at a time (such as Galaxy 5), then set this
  231.       to YES for that/those particular door(s).
  232.      ────────────────────────────────────────────────────────────────────
  233.       I can explain multi node door setup to the best of my ability, as
  234.       most doors must be set up differently for multi node use. What I
  235.       can do, is explain the configuration file use for multi node
  236.       doors. For example, a door that asks for the config file on the
  237.       command line to run the door (DOORNAME FILENAME.CFG), you can
  238.       create separate config files for each node that you have, using
  239.       the setup particular to each node.
  240.      ────────────────────────────────────────────────────────────────────
  241.       Lets say we are setting up DOORNAME under two nodes, nodes 1 and
  242.       2. First we create a configuration file (used by the door) named
  243.       NODE1.CFG. In this config file, we show the door where to find the
  244.       drop file for node one, and if asked for, the com port number for
  245.       the modem on node 1, and/or the IRQ number for node 1 (if asked
  246.       for), and anything else specific to node 1 that the config file
  247.       asks for. So our Wildcat! setup under node one, would point the
  248.       door to the drop file in the C:\WILDCAT\WCWORK\NODE1 directory
  249.       (replacing C:\WILDCAT with your home Wildcat! directory). And if
  250.       the modem that node 1 uses is on COM 4, then we would put 4 on the
  251.       line that asks for the COM port number (if it asks for it), etc.
  252.       We save the file, then copy it to NODE2.CFG (or start a new one),
  253.       and edit this one to point the door to the C:\WILDCAT\WCWORK\NODE2
  254.       directory (again replacing C:\WILDCAT with your home Wildcat!
  255.       directory). And the COM port number the modem that node 2 uses is
  256.       on (if asked for), etc. etc.
  257.      ────────────────────────────────────────────────────────────────────
  258.       Now comes the trickier part. Wildcat! systems (among others) can
  259.       use a "Node ID" variable to determine the node number for each
  260.       different node. In Wildcat!, this variable is WCNODEID and is set
  261.       in the batch files that you start each node from like this,
  262.       SET WCNODEID=1 for node 1, and SET WCNODEID=2 for node 2, etc. If
  263.       you use (or are going to use) the Node ID variables, then you need
  264.       only make one batch file to run the door with, and place it in
  265.       your WILDCAT\BATCH subdirectory (or the batch file directory for
  266.       your particular BBS software). Now in this batch file, you will
  267.       need to call the appropriate config file for the node being ran.
  268.       Here is an example batch file for a multi node door using the
  269.       WCNODEID variable,
  270.  
  271.       @ECHO OFF
  272.       D:
  273.       CD\DOORS\DOORNAME
  274.       DOORNAME NODE%WCNODEID%.CFG
  275.  
  276.       Notice the NODE%WCNODEID%.CFG in the above example. If node 1 was
  277.       running the door, then this command would be passed to DOORNAME,
  278.       DOORNAME NODE1.CFG. And if node 2 was running the door, then the
  279.       above statement would be passed looking like this,
  280.       DOORNAME NODE2.CFG. Anywhere you place %WCNODEID% (case is not
  281.       important) in your batch file(s) for running doors, it will be
  282.       replaced with the proper node number being ran, as long as you use
  283.       the SET WCNODEID=? command in your batch files that start each of
  284.       your BBS nodes replacing ? with the proper node number.
  285.      ────────────────────────────────────────────────────────────────────
  286.       If you are not using the Node ID variables, then for Wildcat!
  287.       systems, you will need to use separate .RUN files instead of one
  288.       .BAT file. These .RUN files are batch files with a .RUN extension,
  289.       and must be placed in your NODE directories. Here is an example
  290.       .RUN file for node 1,
  291.  
  292.       @ECHO OFF
  293.       D:
  294.       CD\DOORS\DOORNAME
  295.       DOORNAME NODE1.CFG
  296.  
  297.       This file must be placed in the C:\WILDCAT\WCWORK\NODE1 directory,
  298.       instead of the C:\WILDCAT\BATCH directory (replacing C:\WILDCAT
  299.       with your home Wildcat! directory). Here is node 2's example,
  300.  
  301.       @ECHO OFF
  302.       D:
  303.       CD\DOORS\DOORNAME
  304.       DOORNAME NODE2.CFG
  305.  
  306.       This file must be placed in the C:\WILDCAT\WCWORK\NODE2 directory,
  307.       instead of the C:\WILDCAT\BATCH directory (replacing C:\WILDCAT
  308.       with your home Wildcat! directory).
  309.      ────────────────────────────────────────────────────────────────────
  310.       Wildcat! always first looks for the .RUN version of your door
  311.       batch files in the node directories when executing a door. If not
  312.       found, then it uses the .BAT file in the BATCH directory.
  313.      ────────────────────────────────────────────────────────────────────
  314.  
  315.  
  316.                                LOCKED BAUD RATES
  317.      ────────────────────────────────────────────────────────────────────
  318.       It is recommended that you lock your baud rate for each node. How
  319.       you ask? Anywhere in any setup pertaining to your BBS or doors
  320.       that asks for the locked baud rate, enter a locked baud rate. If
  321.       you have a 14400 modem or slower, first try locking it at 38400.
  322.       If you have a 19.2 or higher, use 57600. Locking your baud rate
  323.       increases the speed at which text is sent over the modem, and is
  324.       much more effecient.
  325.      ────────────────────────────────────────────────────────────────────
  326.       To lock your baud rate, you must first do so in your BBS setup
  327.       program. In Wildcat!, this is located under "Modem Settings" in
  328.       the MakeWild program. Then, when setting up a door, if it asks
  329.       anywhere for your locked baud rate, you must enter the same value
  330.       there as you did in your BBS setup program. It is not wise to use
  331.       a locked baud rate under one program and not the other! ;> This
  332.       also applies to front end mailers if you use one (Front Door,
  333.       D'Bridge, etc.).
  334.      ────────────────────────────────────────────────────────────────────
  335.  
  336.  
  337.                                 FOSSIL DRIVERS
  338.      ────────────────────────────────────────────────────────────────────
  339.       Alot of doors can use a fossil driver if you are using one. Whats
  340.       a fossil driver you ask? A fossil driver is a TSR that runs your
  341.       COM ports for you. They are more effecient than regular COM
  342.       routines, and are recommended, especially in a multi node
  343.       environment. By far I have found the best fossil driver to be BNU
  344.       by David Nugent. As far as I am aware the most current version is
  345.       2.02. BNU works well under DESQview, and Windows as well as DOS (I
  346.       am not sure about OS/2). I am currently running BNU v2.02 under
  347.       Windows 95 with beyond satisfactory results.
  348.      ────────────────────────────────────────────────────────────────────
  349.       By far the easiest way to setup BNU (in my opinion), is to use the
  350.       BNU.COM version, instead of the BNU.SYS (both are included in the
  351.       archive when you obtain it). The BNU.COM version can be loaded via
  352.       batch files, or directly from the command line. The BNU.SYS
  353.       version must be loaded via your CONFIG.SYS file. The main reason I
  354.       use the .COM version is because I like to unload the fossil driver
  355.       when I take the BBS down. By using the BNU.SYS version, the fossil
  356.       is always resident in memory until you reboot (to my knowledge
  357.       anyway). Refer to BNU's documentation (if you decide to use it)
  358.       for more complete informatin on the fossil driver.
  359.      ────────────────────────────────────────────────────────────────────
  360.       BNU can be used to control all of your COM ports. Be it one or
  361.       four modems, maybe more, I'm not sure, as I said before, refer to
  362.       BNU's documentation for full information on this. If you use the
  363.       .COM version, I personally recommend creating a batch file called
  364.       FOSSIL.BAT (or whatever you wanna name it), containing the full
  365.       command line to load BNU for your system. This way, you can
  366.       CALL FOSSIL.BAT from the batch file(s) that load your BBS (or
  367.       front end mailer if you use one), instead of calling the entire
  368.       command line that BNU must have.
  369.      ────────────────────────────────────────────────────────────────────
  370.       Another important factor when using a fossil driver, is telling
  371.       your BBS software to use the fossil driver. For example, in a
  372.       Wildcat! system, under "Modem Settings," there is a field that
  373.       asks for "Type of Serial Port." If you are using a fossil driver,
  374.       then you must use "Fossil Driver" in this field. Also, you must
  375.       set the field "Determine Ringing Using" to "Ring Result." Then
  376.       set the "Determine Baud Rate Using" field to "Result Code 2."
  377.      ────────────────────────────────────────────────────────────────────
  378.       Here are the basic settings to get you started using BNU.COM. If
  379.       you are unfamiliar with BNU, try these settings first (replacing
  380.       the appropriate info where necessary). Of course, in order to use
  381.       BNU, you should first place the BNU.COM file somewhere in your
  382.       path statement. The example used below, is for one modem (one
  383.       node) where the modem is connected to COM port 1, and is equal to
  384.       or faster than 14400. If these settings do not work for you, then
  385.       tweak them as you need to.
  386.  
  387.       BNU /P:1 /L0:57600 /F+ /Z0 /M- /T:3072 /R:3072 /O
  388.  
  389.        Here is an explanation of the above switches used
  390.       ---------------------------------------------------
  391.       /P: = Tells BNU how many ports to enable. (/P:2 enables 2 ports).
  392.       /L0 = Tells BNU what baud rate to lock the specified COM port at.
  393.             The COM port specified in this case is 1. Notice that a 0 is
  394.             used instead of 1. When refering to the actual COM port
  395.             number in BNU, you must decrease the value by one. For
  396.             example, COM 2 would be /L1, COM 3 would be /L2, etc.
  397.       /F+ = Enables fast screen writes. To disable fast screen writes,
  398.             use /F-.
  399.       /Z0 = This is used if you have a 16550 FIFO buffer. I believe this
  400.             is in your modem specifications. Most modems that are 14.4
  401.             and faster, and do not require any software drivers to run,
  402.             do have 16550 FIFO's. If you have problems with BNU, try
  403.             either removing this command, or changing it to /Z5 which
  404.             disables 16550 FIFO buffering.
  405.       /M- = Disables the BNU initialization message. Normally BNU shows
  406.             its loading stats to the screen, you can disable it with
  407.             this switch, or enable it by removing this switch, or
  408.             changing it to /M+.
  409.       /T: = Sets the transmit buffer size. In this case the value is set
  410.             to 3072. This shouldn't normally have to be changed. If you
  411.             do need to reduce it however, change it to /T:2048.
  412.       /R: = Sets the receive buffer size. This is also set to 3072. If
  413.             you need to reduce it for some reason, change it to /R:2048.
  414.       /O  = This switch is used to enable "compatible" operation of BNU
  415.             in situations where either X00 or Opus!Com worked (other
  416.             fossil drivers), but BNU didn't. It should be used by
  417.             default at all times unless you can get away with omitting
  418.             it.
  419.      ────────────────────────────────────────────────────────────────────
  420.  
  421.  
  422.                                    NOT ENUFF
  423.      ────────────────────────────────────────────────────────────────────
  424.       If the above information does not help you out enough, feel free
  425.       to contact me with your question(s) regarding what it is you need
  426.       help with. I am always glad to help, and will give you all the
  427.       info I can to help you get started setting up doors on your
  428.       system! ;>
  429.      ────────────────────────────────────────────────────────────────────
  430.       BBS      : The Last Call BBS! (313) 295-6284
  431.       Fido     : 1:2410/903
  432.       Internet : tsmith2@voyager.net
  433.       WWW      : http://www.geocities.com/SiliconValley/Heights/2233
  434.      ────────────────────────────────────────────────────────────────────
  435.       I also frequent the following echos on FidoNet,
  436.                                                      DOORGAMES
  437.                                                      DOORWARE
  438.                                                      ON_LINE_GAMES
  439.      ────────────────────────────────────────────────────────────────────
  440.                          Hope this helped! Good Luck!
  441.      ────────────────────────────────────────────────────────────────────
  442.  
  443.                                 ■ END OF FILE ■
  444.